Skip to content

docs: explicitly call out when userinfo and tokens in paths are supported#360

Open
apoclyps wants to merge 1 commit intomainfrom
kyleharrison/no-ticket/clarify-generic-docs
Open

docs: explicitly call out when userinfo and tokens in paths are supported#360
apoclyps wants to merge 1 commit intomainfrom
kyleharrison/no-ticket/clarify-generic-docs

Conversation

@apoclyps
Copy link
Contributor

@apoclyps apoclyps commented Mar 6, 2026

What's Changed

To help provide clarify on authentication mechanisms and on which domains they are supported.

we include an example of which authentication uses userinfo and which uses a token in the path e.g. scheme://userinfo@host:port/path?query#fragment

  • the token:TOKEN is the user info in the url which comes before the host. This is only supported on the generic.cloudsmith.io domain
  • the entitlement token is embedded in the path portion of the URI, e.g., after the domain, like dl.cloudsmith.io/TOKEN/OWNER/REPOSITORY, and it's only supported on the download domain.

@apoclyps apoclyps self-assigned this Mar 6, 2026
Copilot AI review requested due to automatic review settings March 6, 2026 11:00
@vercel
Copy link

vercel bot commented Mar 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cloudsmith-docs Ready Ready Preview, Comment Mar 6, 2026 11:16am

Request Review

@apoclyps apoclyps requested a review from jtaylor-cs March 6, 2026 11:00
@apoclyps apoclyps force-pushed the kyleharrison/no-ticket/clarify-generic-docs branch from 773362f to bb2792b Compare March 6, 2026 11:02
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Clarifies which authentication mechanisms are supported for Generic package downloads, explicitly distinguishing userinfo-based HTTP Basic Auth on generic.cloudsmith.io vs path-token authentication on dl.cloudsmith.io.

Changes:

  • Refines the “Private Repositories” authentication guidance and examples for generic.cloudsmith.io.
  • Adds an API key (header-based) download example for generic.cloudsmith.io.
  • Expands and restructures documentation for dl.cloudsmith.io path-based authentication and adds a “Supported Authentication by Domain” summary table plus guidance on when to use dl.cloudsmith.io.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@apoclyps apoclyps force-pushed the kyleharrison/no-ticket/clarify-generic-docs branch from 9e20988 to cbd019f Compare March 6, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants